Enable exporting (registered) submission metadata #4962
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4962 +/- ##
==========================================
+ Coverage 96.64% 96.65% +0.01%
==========================================
Files 760 762 +2
Lines 25844 25935 +91
Branches 3387 3391 +4
==========================================
+ Hits 24976 25067 +91
Misses 604 604
Partials 264 264 ☔ View full report in Codecov by Sentry. |
robinmolen
reviewed
Dec 24, 2024
robinmolen
reviewed
Dec 24, 2024
| def export(self) -> Dataset: | ||
| start_date: date = self.cleaned_data["start_date"] | ||
| end_date: date = self.cleaned_data["end_date"] | ||
| return export_registration_statistics( |
There was a problem hiding this comment.
Maybe a bit picky, but why do you define the dates as variables? Is it (only) to specify the date typing?
Otherwise, why not just pass the cleaned_data directly?
There was a problem hiding this comment.
A couple of reasons, all summarized as "loose coupling".
- A simple
export_registration_statisticswith plain parameters is easy to understand when you're in that function, without adding the cognitive overhead of knowing what the form structure looks like and what's incleaned_data. - Building on top of 1., I can modify my form implementation and interface without needing to touch the actual export function. If I have to touch the export function, I'm very well aware that I'm changing a Python API and need to check for possible other call sites.
- The export function can also be called through other user interfaces, e.g. a management command/CLI where the date parameters get passed/parsed differently, or a celery task could be wired up to periodically generate these and automatically prepare/send the exports.
- Explicit type annotations are nice indeed :)
robinmolen
reviewed
Dec 24, 2024
|
I've tried the export, and was missing some submissions.. I'm not yet sure why, i'll take another look later today.. |
Export submission statistics based on the timeline logs. Note: if the timeline logs are pruned, this affects the exports. It's up to the users to periodically create these exports and save them somewhere if they periodically prune log records. Note 2: filtering on forms only works on new log records, as existing log records don't have the form ID stored in the structured data. Submissions that were deleted for which existing log records are present will display 'unknown' for some columns because the relevant information has been deleted. Only from 3.0 onwards are we snapshotting the data required for the exports.
Ensures that the filters are correctly implemented.
sergei-maertens
force-pushed
the
feature/4930-bulk-export-submission-stats
branch
from
5627a76 to
d8b516e
Compare
sergei-maertens
deleted the
feature/4930-bulk-export-submission-stats
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #4930
Changes
Checklist
Check off the items that are completed or not relevant.
Impact on features
Release management
I have updated the translations assets (you do NOT need to provide translations)
./bin/makemessages_js.sh./bin/compilemessages_js.shDockerfile/scripts
./binfolderCommit hygiene